<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>Credentials xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/com/googlecode/gmail4j/auth/Credentials.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright (c) 2008-2009 Tomas Varaneckas</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> * <a href="http://www.varaneckas.com" target="alexandria_uri">http://www.varaneckas.com</a></em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * </em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> * This program is free software: you can redistribute it and/or modify</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * it under the terms of the GNU General Public License as published by</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * the Free Software Foundation, either version 3 of the License, or</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * (at your option) any later version.</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> * </em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * This program is distributed in the hope that it will be useful,</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * GNU General Public License for more details.</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * </em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * You should have received a copy of the GNU General Public License</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * along with this program. If not, see &lt;<a href="http://www.gnu.org/licenses/&gt;." target="alexandria_uri">http://www.gnu.org/licenses/&gt;.</a></em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> com.googlecode.gmail4j.auth;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gmail4j.GmailException;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gmail4j.util.LoginDialog;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment">/**</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * Login credentials containing username and password.</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * This class stores password as a &lt;code&gt;char[]&lt;/code&gt; and allows you to dispose</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * the array via {@link #dispose()} to avoid sniffing.</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * There are several ways to construct your &lt;code&gt;Credentials&lt;/code&gt;:</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;&lt;blockquote&gt;&lt;pre&gt;</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> *     String username = ...</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> *     char[] password = ...</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> *     Credentials login = new Credentials(username, password);</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> *     //password char array is cleared automatically</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;&lt;/blockquote&gt;&lt;p&gt;</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * Another approach:</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;&lt;blockquote&gt;&lt;pre&gt;</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> *     String username = ...</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> *     char[] password = ...</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> *     Credentials login = new Credentials();</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> *     login.setUsername(username);</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> *     login.setPassword(password)</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> *     //password char array is cleared automatically</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;&lt;/blockquote&gt;&lt;p&gt;</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * For testing purposes you can construct &lt;code&gt;Credentials&lt;/code&gt; with help of </em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * {@link LoginDialog#show(String)}</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;&lt;blockquote&gt;&lt;pre&gt;</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> *     Credentials login = LoginDialog.show("Gmail Login");</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;&lt;/blockquote&gt;&lt;p&gt;</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * There are more methods of interest: </em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * &lt;ul&gt;&lt;li&gt;{@link #validate()} checks if</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * username and password were provided and throws {@link GmailException} in case</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * something is missing.&lt;/li&gt;</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;{@link #dispose()} clears the username and password to prevent further </em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * use.&lt;/li&gt;&lt;/ul&gt;</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * </em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * @author Tomas Varaneckas &amp;lt;tomas.varaneckas@gmail.com&amp;gt;</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * @version $Id: Credentials.java 11 2009-03-20 12:31:30Z tomas.varaneckas $</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> * @since 0.1</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> */</em>
<a name="61" href="#61">61</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../com/googlecode/gmail4j/auth/Credentials.html">Credentials</a> {
<a name="62" href="#62">62</a>  
<a name="63" href="#63">63</a>      <em class="jxr_javadoccomment">/**</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     * Password stored as &lt;code&gt;char[]&lt;/code&gt; to enable secure disposal </em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     */</em>
<a name="66" href="#66">66</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">char</strong>[] password;
<a name="67" href="#67">67</a>  
<a name="68" href="#68">68</a>      <em class="jxr_javadoccomment">/**</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     * Username</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     */</em>
<a name="71" href="#71">71</a>      <strong class="jxr_keyword">private</strong> String username;
<a name="72" href="#72">72</a>  
<a name="73" href="#73">73</a>      <em class="jxr_javadoccomment">/**</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * Argless constructor to enable setter based configuration.</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * You will have to manually call {@link #setUsername(String)} and </em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * {@link #setPassword(char[])} (nd optionally {@link #validate()}</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     * afterwards;</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     */</em>
<a name="80" href="#80">80</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../com/googlecode/gmail4j/auth/Credentials.html">Credentials</a>() {
<a name="81" href="#81">81</a>          <em class="jxr_comment">//nothing to do</em>
<a name="82" href="#82">82</a>      }
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>      <em class="jxr_javadoccomment">/**</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * Constructor that sets {@link #username} and {@link #password}. Given</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * &lt;code&gt;password char[]&lt;/code&gt; argument gets cleared for security purposes.</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     * It also calls {@link #validate()} automatically to check if user/pass</em>
<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     * is not empty. </em>
<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * </em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     * @param username Username</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * @param password Password</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     */</em>
<a name="94" href="#94">94</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../com/googlecode/gmail4j/auth/Credentials.html">Credentials</a>(<strong class="jxr_keyword">final</strong> String username, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] password) {
<a name="95" href="#95">95</a>          setUsername(username);
<a name="96" href="#96">96</a>          setPassword(password);
<a name="97" href="#97">97</a>          validate();
<a name="98" href="#98">98</a>      }
<a name="99" href="#99">99</a>      
<a name="100" href="#100">100</a>     <em class="jxr_javadoccomment">/**</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     * Validates existence of {@link #username} and {@link #password} properties.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * </em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * @throws GmailException in case username and/or password are missing.</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     */</em>
<a name="105" href="#105">105</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> validate() {
<a name="106" href="#106">106</a>         <strong class="jxr_keyword">if</strong> (username == <strong class="jxr_keyword">null</strong> || username.length() == 0 
<a name="107" href="#107">107</a>                 ||password == <strong class="jxr_keyword">null</strong> || password.length == 0) {
<a name="108" href="#108">108</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../com/googlecode/gmail4j/GmailException.html">GmailException</a>(<span class="jxr_string">"No username and/or password provided"</span>);
<a name="109" href="#109">109</a>         }
<a name="110" href="#110">110</a>     }
<a name="111" href="#111">111</a>  
<a name="112" href="#112">112</a>     <em class="jxr_javadoccomment">/**</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * Sets {@link #username}</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * </em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     * @param username Username</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     */</em>
<a name="117" href="#117">117</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUsername(<strong class="jxr_keyword">final</strong> String username) {
<a name="118" href="#118">118</a>         <strong class="jxr_keyword">this</strong>.username = username;
<a name="119" href="#119">119</a>     }
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>     <em class="jxr_javadoccomment">/**</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * Sets {@link #password} and clears the given &lt;code&gt;char[]&lt;/code&gt; argument</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * for security purposes.</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * </em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * @param password Password</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     */</em>
<a name="127" href="#127">127</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPassword(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] password) {
<a name="128" href="#128">128</a>         <strong class="jxr_keyword">this</strong>.password = <strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">char</strong>[password.length];
<a name="129" href="#129">129</a>         System.arraycopy(password, 0, <strong class="jxr_keyword">this</strong>.password, 0, password.length);
<a name="130" href="#130">130</a>         disposePassword(password);
<a name="131" href="#131">131</a>     }
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>     <em class="jxr_javadoccomment">/**</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * Disposes a given &lt;code&gt;char[]&lt;/code&gt;. A way to destroy password arguments.</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * </em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     * @param password Password for disposal</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     */</em>
<a name="138" href="#138">138</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> disposePassword(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] password) {
<a name="139" href="#139">139</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; password.length; i++) {
<a name="140" href="#140">140</a>             password[i] = 0;
<a name="141" href="#141">141</a>         }
<a name="142" href="#142">142</a>     }
<a name="143" href="#143">143</a> 
<a name="144" href="#144">144</a>     <em class="jxr_javadoccomment">/**</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     * Gets {@link #password}</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     * @return A reference to password &lt;code&gt;char[]&lt;/code&gt;</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     */</em>
<a name="148" href="#148">148</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">char</strong>[] getPasword() {
<a name="149" href="#149">149</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.password;
<a name="150" href="#150">150</a>     }
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>     <em class="jxr_javadoccomment">/**</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * Gets {@link #username}</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * </em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * @return Username</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     */</em>
<a name="157" href="#157">157</a>     <strong class="jxr_keyword">public</strong> String getUsername() {
<a name="158" href="#158">158</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.username;
<a name="159" href="#159">159</a>     }
<a name="160" href="#160">160</a>     
<a name="161" href="#161">161</a>     <em class="jxr_javadoccomment">/**</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     * Disposes current &lt;code&gt;Credentials&lt;/code&gt; instance by clearing </em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * {@link #username} and {@link #password}.</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     * Object can be reused again with new {@link #username} and </em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">     * {@link #password}</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">     * </em>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * @see #disposePassword(char[])</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     */</em>
<a name="170" href="#170">170</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> dispose() {
<a name="171" href="#171">171</a>         <strong class="jxr_keyword">this</strong>.username = <strong class="jxr_keyword">null</strong>;
<a name="172" href="#172">172</a>         disposePassword(<strong class="jxr_keyword">this</strong>.password);
<a name="173" href="#173">173</a>         <strong class="jxr_keyword">this</strong>.password = <strong class="jxr_keyword">null</strong>;
<a name="174" href="#174">174</a>     }
<a name="175" href="#175">175</a>     
<a name="176" href="#176">176</a>     @Override
<a name="177" href="#177">177</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> finalize() <strong class="jxr_keyword">throws</strong> Throwable {
<a name="178" href="#178">178</a>         dispose();
<a name="179" href="#179">179</a>         <strong class="jxr_keyword">super</strong>.finalize();
<a name="180" href="#180">180</a>     }
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

